home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / dmedia / dmGetError.z / dmGetError
Encoding:
Text File  |  2002-10-03  |  6.2 KB  |  133 lines
  1.  
  2.  
  3.  
  4. ddddmmmmGGGGeeeettttEEEErrrrrrrroooorrrr((((3333ddddmmmm))))                                                ddddmmmmGGGGeeeettttEEEErrrrrrrroooorrrr((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      dmGetError, dmGetErrorForPID - retrieve an error number, message, and
  10.      detail for Digital Media errors
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ddddmmmmeeeeddddiiiiaaaa....hhhh>>>>
  14.  
  15.      ccccoooonnnnsssstttt cccchhhhaaaarrrr ****ddddmmmmGGGGeeeettttEEEErrrrrrrroooorrrr((((iiiinnnntttt ****eeeerrrrrrrroooorrrrnnnnuuuummmm,,,,
  16.                             cccchhhhaaaarrrr eeeerrrrrrrroooorrrr____ddddeeeettttaaaaiiiillll[[[[DDDDMMMM____MMMMAAAAXXXX____EEEERRRRRRRROOOORRRR____DDDDEEEETTTTAAAAIIIILLLL]]]]))))
  17.  
  18.      ccccoooonnnnsssstttt cccchhhhaaaarrrr ****ddddmmmmGGGGeeeettttEEEErrrrrrrroooorrrrFFFFoooorrrrPPPPIIIIDDDD((((ppppiiiidddd____tttt ppppiiiidddd,,,, iiiinnnntttt ****eeeerrrrrrrroooorrrrnnnnuuuummmm,,,,
  19.                             cccchhhhaaaarrrr eeeerrrrrrrroooorrrr____ddddeeeettttaaaaiiiillll[[[[DDDDMMMM____MMMMAAAAXXXX____EEEERRRRRRRROOOORRRR____DDDDEEEETTTTAAAAIIIILLLL]]]]))))
  20.  
  21. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  22.      _p_i_d            The process id in which to check for an error.  In
  23.                     ddddmmmmGGGGeeeettttEEEErrrrrrrroooorrrr(((()))), this defaults to the current pid as returned
  24.                     by ggggeeeettttppppiiiidddd(2).
  25.  
  26.      _e_r_r_o_r_n_u_m       A pointer to an integer into which the error number of the
  27.                     current error will be loaded.  If _e_r_r_o_r_n_u_m is NULL, it
  28.                     will be ignored.
  29.  
  30.      _e_r_r_o_r__d_e_t_a_i_l   The address of a char array of size DDDDMMMM____MMMMAAAAXXXX____EEEERRRRRRRROOOORRRR____DDDDEEEETTTTAAAAIIIILLLL,
  31.                     allocated in the application's memory space.  A detailed
  32.                     description of the error will be loaded into this array,
  33.                     if such a description is available.  This string will be
  34.                     null-terminated.  If _e_r_r_o_r__d_e_t_a_i_l is NULL, it will be
  35.                     ignored.
  36.  
  37. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  38.      ddddmmmmGGGGeeeettttEEEErrrrrrrroooorrrr(((()))) is designed to allow an application to handle error
  39.      conditions generated within a large number of independent digital media
  40.      units (i.e., the Movie Libraries, the Audio File Library, Audio
  41.      Conversion and Image Conversion utilities) in a single location.  In
  42.      addition to the short error string returned by the function call, an
  43.      application may also optionally retrieve a more detailed description of
  44.      the error plus the actual error number.  The internal setting and public
  45.      retrieval of these errors is guaranteed to be thread-safe.
  46.  
  47. RRRREEEETTTTUUUURRRRNNNNEEEEDDDD VVVVAAAALLLLUUUUEEEE
  48.      Returns a pointer to a null-terminated character string (in static
  49.      memory) which indicates the category of the error.  Only the most recent
  50.      error for a given thread will be returned.  If no errors have occurred,
  51.      ddddmmmmGGGGeeeettttEEEErrrrrrrroooorrrr(((()))) returns NULL.
  52.  
  53. EEEERRRRRRRROOOORRRR NNNNUUUUMMMMBBBBEEEERRRRSSSS
  54.      The error numbers returned in _e_r_r_o_r_n_u_m fall into ranges determined by the
  55.      digital media unit which generated it.  The currently defined ranges are
  56.      as follows:
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ddddmmmmGGGGeeeettttEEEErrrrrrrroooorrrr((((3333ddddmmmm))))                                                ddddmmmmGGGGeeeettttEEEErrrrrrrroooorrrr((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      0000----999999999999         UNIX System Errors (identical to those returned via
  75.                    oooosssseeeerrrrrrrroooorrrr(3c)
  76.  
  77.      1111000000000000----1111999999999999     Color Space Library Errors (libdmedia)
  78.  
  79.      2222000000000000----2222999999999999     Movie Library Errors (libmoviefile, libmovieplay)
  80.  
  81.      3333000000000000----3333999999999999     Audio File Library Errors (libaudiofile)
  82.  
  83.      4444000000000000----4444999999999999     DMbuffer Errors (libdmedia)
  84.  
  85.      5555000000000000----5555999999999999     Audio Converter Errors (libdmedia)
  86.  
  87.      6666000000000000----6666999999999999     Image Converter Errors (libdmedia)
  88.  
  89.      11110000000000000000----11110000999999999999   Global Digital Media Library Errors (libdmedia)
  90.  
  91.      11111111000000000000----11111111999999999999   FX Plug-in Utility Library Errors (libfxplugutils)
  92.  
  93.      11112222000000000000----11112222999999999999   FX Plug-in Manager Library Errors (libfxplugmgr)
  94.  
  95. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  96.      mvIntro(3dm), mvGetErrno(3dm), afIntro(3dm), dmedia(3dm)
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.